//
//    Copyright (c) 2015 Shyam Bhat
//
//    Permission is hereby granted, free of charge, to any person obtaining a copy of
//    this software and associated documentation files (the "Software"), to deal in
//    the Software without restriction, including without limitation the rights to
//    use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
//    the Software, and to permit persons to whom the Software is furnished to do so,
//    subject to the following conditions:
//
//    The above copyright notice and this permission notice shall be included in all
//    copies or substantial portions of the Software.
//
//    THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
//    IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
//    FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
//    COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
//    IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
//    CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

#import <Foundation/Foundation.h>

NS_ASSUME_NONNULL_BEGIN

@interface InstagramPaginationInfo : NSObject <NSCopying, NSSecureCoding, NSObject>

/**
 *  URL to receive next set of paginated items.
 */
@property (nonatomic, readonly) NSURL* nextURL;

/**
 *  Offset from which the next paginated Media is to be received.
 */
@property (nonatomic, readonly, copy) NSString *nextMaxId;

/**
 *  Class of Objects which are being paginated.
 */
@property (nonatomic, readonly, nullable) Class type;

/**
 *  Initializes a new InstagramPaginationInfo object.
 *
 *  @param info Received JSON dictionary.
 *  @param type Class of Objects which are being paginated.
 */
- (instancetype)initWithInfo:(NSDictionary *)info andObjectType:(Class)type;

/**
 *  Comparing InstagramPaginationInfo objects.
 *  @param paginationInfo   An InstagramPaginationInfo object.
 *  @return                 YES is nextURLs match. Else NO.
 */
- (BOOL)isEqualToPaginationInfo:(InstagramPaginationInfo *)paginationInfo;

@end

NS_ASSUME_NONNULL_END
